

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Version Control with TFS [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Version Control,Version Control TFS Options,TFS,TFS Version Control Options,Team Foundation Server,Team Foundation Server Version Control Options">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Version Control with TFS</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="tortoisesvn.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="usingversioncontrol.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">In order to use Team Foundation Server for version control with Enterprise Architect, all users must have either the TFS command line client (</span><span class="f_BodyText" style="font-style: italic;">tf.exe</span><span class="f_BodyText">) or Microsoft's Team Foundation Server MSSCCI installed on their local machine. Each intended user must also have an account that provides read/write access to a workspace on the server.</span></p>
<p class="p_BodyText"><span class="f_BodyText">This topic covers configuring version control using the TFS command line client. To configure version control with the TFS MSSCCI client, please follow the instructions in the </span><span class="f_BodyText" style="font-style: italic;"><a href="versioncontroloptionsscc.htm">Version Control with SCC</a></span><span class="f_BodyText"> topic.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Each user must set up a local working folder on their own machine that is mapped, through the workspace, to a Source Control folder on the server.</span></p>
<p class="p_BodyText"><span class="f_BodyText">These preliminary steps should be performed on each PC and for each user, before making any attempt to define a Version Control Configuration within Enterprise Architect that uses TFS.</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Connect an Enterprise Architect Model to Version Control using TFS</span></p>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=1><span class="f_NumberedList">Open or create the Enterprise Architect model to place under version control.</span></li>
<li value=2><span class="f_NumberedList">Select the </span><span class="f_MenuKeyField">Project | Version Control | Version Control Settings</span><span class="f_NumberedList"> menu option. The </span><span class="f_UIControl">Version Control Settings</span><span class="f_NumberedList"> dialog displays.</span></li>
<li value=3><span class="f_NumberedList">Click on the </span><span class="f_MenuKeyField">New</span><span class="f_NumberedList"> button, in the </span><span class="f_MenuKeyField">Unique ID</span><span class="f_NumberedList"> field enter a suitable name, then select the </span><span class="f_MenuKeyField">TFS</span><span class="f_NumberedList"> radio button.</span><br>
<span class="f_NumberedList">&nbsp;</span><br>
<img src="dlgvcconfigstfs.png" width="516" height="646" border="0" alt="DlgVCConfigsTFS"><br>
<span class="f_NumberedList">&nbsp;</span></li>
<li value=4><span class="f_NumberedList">Click on the </span><span class="f_MenuKeyField">Select Path... </span><span class="f_NumberedList">button to the right of the </span><span class="f_MenuKeyField">Working Copy path</span><span class="f_NumberedList"> field, and select the local folder in which to keep local working copies of the XML files to be stored in the Version Control repository.</span></li>
</ol>
<div style="text-align: left; text-indent: -21px; padding: 0px 0px 0px 0px; margin: 5px 0px 0px 48px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">Enterprise Architect queries TFS to retrieve the Server and Workspace names associated with this folder, when attempting to save the configuration data.</span></p>
</td>
</tr>
</table>
</div>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=5><span class="f_NumberedList">In the </span><span class="f_MenuKeyField">User Name</span><span class="f_NumberedList"> and </span><span class="f_MenuKeyField">Password</span><span class="f_NumberedList"> fields, type values that enable access to the TFS workspace associated with the Working Copy path specified above.</span></li>
</ol>
<div style="text-align: left; text-indent: -21px; padding: 0px 0px 0px 0px; margin: 5px 0px 0px 48px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">Users who automatically log in to TFS through means external to Enterprise Architect (for example, through MS Integrated Security) can leave the </span><span class="f_MenuKeyField">User Name</span><span class="f_TiporNoteText"> and </span><span class="f_MenuKeyField">Password</span><span class="f_TiporNoteText"> fields blank. If the </span><span class="f_MenuKeyField">Password</span><span class="f_TiporNoteText"> field is blank, Enterprise Architect retrieves the current user's Windows username and uses that value when determining whether a package is checked out to them or to some other user.</span></p>
</td>
</tr>
</table>
</div>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=6><span class="f_NumberedList">The </span><span class="f_MenuKeyField">TFS Exe Path</span><span class="f_NumberedList"> field displays the default installation path. Click on the </span><span class="f_MenuKeyField">Select Path...</span><span class="f_NumberedList"> button if it is necessary to modify this field.</span></li>
<li value=7><span class="f_NumberedList">Click on the</span><span class="f_MenuKeyField"> Save</span><span class="f_NumberedList"> button to save the configuration you have defined.</span></li>
<li value=8><span class="f_NumberedList">The new configuration is added to the list in the </span><span class="f_UIControl">Defined Configurations</span><span class="f_NumberedList"> panel.</span></li>
</ol>
<div style="text-align: left; text-indent: -21px; padding: 0px 0px 0px 0px; margin: 5px 0px 0px 48px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">A new entry is also created in the <a href="localpathdlg.htm">Local Paths</a> list, with the same ID as the new version control configuration. The </span><span class="f_MenuKeyField">Local Path</span><span class="f_TiporNoteText"> entry records the Local Project path, for use in subsequent path substitutions.</span></p>
</td>
</tr>
</table>
</div>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=9><span class="f_NumberedList">When you have finished defining your version control configurations, click on the </span><span class="f_MenuKeyField">Close</span><span class="f_NumberedList"> button.</span></li>
</ol>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Additional Information on the Dialog Fields</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" bgcolor="#e3e6ed" style="width:187px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Option</span></p>
</td>
<td valign="top" width="486" bgcolor="#e3e6ed" style="width:486px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Use to</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">This model is private</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Specify whether all users connect to a single shared copy of the model (e.g. a DBMS) or each user connects to their own private copy of the model.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">When unselected (for shared models), the option disables the </span><span class="f_Tabletext" style="font-weight: bold;">File History - Retrieve</span><span class="f_Tabletext"> functionality when the selected package is checked out by another user. This prevents modifications that might have been made by the other user from being discarded through importing a prior revision from version control.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Save nested version controlled packages to stubs only</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Set nested version controlled packages to stubs or fully expanded trees. Defaults to selected.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">For a full explanation of this option, see</span><span class="f_Tabletext"> <a href="usingnestedversioncontrolp.htm">Use Nested Version Control Packages</a>.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Unique ID</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Specify a configuration name that readily distinguishes it from other configurations.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">The Unique ID is added to the list of Version Control configurations a package can connect to. In addition it is possible to select a previous version control configuration from this drop-down menu providing the configuration is not in the current model.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Working Copy Path</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Specify the folder where the XML files representing the packages are stored. This folder should already exist before it is specified.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Every PC using TFS version control should have its own TFS Local Folder in which to store working copies of the XMI package files - this should not be a shared network folder. Particularly bear this in mind if you are creating a .EAP file which is to be shared (e.g. a SQL database).</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Server Name</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Specify the name of the Team Foundation Server to connect to.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Workspace Name</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Specify the name of a pre-defined TFS workspace that you are using.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">User Name</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Specify the user name that you use to connect to the Team Foundation Server. The user name that you specify should give you read/write permissions in the specified workspace.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Password</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Specify the password associated with the user name you specify. Enterprise Architect stores this password, in encrypted form, as part of the version control configuration data.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="187" style="width:187px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">TFS Exe Path</span></p>
</td>
<td valign="top" width="486" style="width:486px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Browse to and select the full path name of the TFS command line client's executable file.</span></p>
</td>
</tr>
</table>
</div>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Notes:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><ul style="text-indent: 0px; margin-left: 14px; list-style-position: outside;">
<li><span class="f_TiporNoteText">Sparx Systems strongly urge you not to manipulate version controlled package files outside of Enterprise Architect. It is possible to leave the package files in a state that Enterprise Architect cannot recognize.</span></li>
<li><span class="f_TiporNoteText">Visual Studio Integration (MDG Integration for Visual Studio 2005) enhances TFS support by providing access to, for example, work items and bugs within both Enterprise Architect and the MDG Integration product.</span></li>
</ul>
</td>
</tr>
</table>
</div>




            </div>
          </div>
        </div>



</div>


</body>
</html>
